Node / meshtastic / Meshtastic-Android / files / feature / settings / src / commonMain / kotlin / org / meshtastic / feature / settings / debugging / LogFormatter.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.settings.debugging

Tff7b72import T7ee787kotlinx.datetime.LocalDateTime

Tff7b72import T7ee787kotlinx.datetime.TimeZone

Tff7b72import T7ee787kotlinx.datetime.format

Tff7b72import T7ee787kotlinx.datetime.format.char

Tff7b72import T7ee787kotlinx.datetime.toLocalDateTime

Tff7b72import T7ee787org.meshtastic.core.common.util.nowMillis

Tff7b72import T7ee787kotlin.time.Instant.Companion.fromEpochMilliseconds

T8b949e// `psk` is channel key material and reaches the debug log via set_channel / get_channel_response like any other field.

Tff7b72internal Tff7b72val Te6edf3redactedKeys Tff7b72= Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ffsession_passkeyTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffprivate_keyTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffadmin_keyTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffpskTa5d6ff"Tb4b4b4)

T8b949e// Matches `key: value`, `key=value`, `key=[hex=..]`, and one level of nested list like `admin_key=[[hex=..], [..]]`.

T8b949e// The value alternation is ordered bracket-list | quoted | bare-token so the widest match wins.

Tff7b72private Tff7b72val Te6edf3REDACT_REGEX Tff7b72=

Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff(Tffd700${Te6edf3redactedKeysTb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Tff7b72|Ta5d6ff"Tb4b4b4)Tffd700}Ta5d6ff)Ta5d6ff\\Ta5d6ffs*([:=])Ta5d6ff\\Ta5d6ffs*(Ta5d6ff\\Ta5d6ff[(?:[^Ta5d6ff\\Ta5d6ff[Ta5d6ff\\Ta5d6ff]]|Ta5d6ff\\Ta5d6ff[[^Ta5d6ff\\Ta5d6ff]]*Ta5d6ff\\Ta5d6ff])*Ta5d6ff\\Ta5d6ff]|Ta5d6ff\"Ta5d6ff[^Ta5d6ff\"Ta5d6ff]*Ta5d6ff\"Ta5d6ff|Ta5d6ff\\Ta5d6ffS+)Ta5d6ff"Tb4b4b4)

T8b949e/**

* Matches an undecoded binary `payload` field in a proto `toString()`, in every shape okio can render it.

*

* Structured redaction alone is not enough: a `set_channel` AdminMessage carries the channel PSK inside its serialised

* payload, so the raw bytes have to go too. okio has three renderings for a `ByteString` and the byte count selects

* between them — `[hex=..]` at 64 bytes or fewer, `[size=N hex=..…]` above that. Matching only the first leaves the key

* intact for every payload large enough to matter, which is most of them.

*

* `[text=..]` is deliberately NOT matched here: that rendering only occurs for a valid-UTF-8 payload, i.e. message

* content rather than key material, and its content is unbounded and unescaped so it cannot be delimited reliably. The

* export warning discloses that message text is present.

*/

Tff7b72private Tff7b72val Te6edf3PAYLOAD_HEX_REGEX Tff7b72= Te6edf3RegexTb4b4b4(Ta5d6ff"""Ta5d6ff(payload)Ta5d6ff\Ta5d6ffs*([:=])Ta5d6ff\Ta5d6ffs*Ta5d6ff\Ta5d6ff[(?:size=Ta5d6ff\Ta5d6ffd+ )?hex=[0-9a-fA-F]*…?]Ta5d6ff"""Tb4b4b4)

T8b949e/** Builds a collision-free export file name, e.g. `meshtastic_logcat_20260701_143312.txt`. */

Tff7b72internal Tff7b72fun Td2a8fftimestampedExportNameTb4b4b4(Te6edf3prefixTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72val Te6edf3format Tff7b72=

Te6edf3LocalDateTimeTb4b4b4.Te6edf3Format Tb4b4b4{

Te6edf3yearTb4b4b4(Tb4b4b4)

Te6edf3monthNumberTb4b4b4(Tb4b4b4)

Te6edf3dayTb4b4b4(Tb4b4b4)

Te6edf3charTb4b4b4(Ta5d6ff'_'Tb4b4b4)

Te6edf3hourTb4b4b4(Tb4b4b4)

Te6edf3minuteTb4b4b4(Tb4b4b4)

Te6edf3secondTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tff7b72val Te6edf3timestamp Tff7b72= Te6edf3fromEpochMillisecondsTb4b4b4(Te6edf3nowMillisTb4b4b4)Tb4b4b4.Te6edf3toLocalDateTimeTb4b4b4(Te6edf3TimeZoneTb4b4b4.Te6edf3UTCTb4b4b4)Tb4b4b4.Te6edf3formatTb4b4b4(Te6edf3formatTb4b4b4)

Tff7b72return Ta5d6ff"Tffd700${Te6edf3prefixTffd700}Ta5d6ff_Tffd700$Te6edf3timestampTa5d6ff.txtTa5d6ff"

Tb4b4b4}

T8b949e/**

* Formats a list of [DebugViewModel.UiMeshLog] entries into the given [Appendable], redacting sensitive keys in decoded

* payloads.

*/

Tff7b72internal Tff7b72fun Td2a8ffformatLogsToTb4b4b4(Tff7b72outTb4b4b4: Te6edf3AppendableTb4b4b4, Te6edf3logsTb4b4b4: Te6edf3ListTff7b72<Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTff7b72>Tb4b4b4) Tb4b4b4{

Te6edf3logsTb4b4b4.Te6edf3forEach Tb4b4b4{ Te6edf3log Tff7b72-Tff7b72>

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Tffd700${Te6edf3logTb4b4b4.Te6edf3formattedReceivedDateTffd700}Ta5d6ff [Tffd700${Te6edf3logTb4b4b4.Te6edf3messageTypeTffd700}Ta5d6ff]Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

T8b949e// logMessage is the annotated proto toString, so it carries both structured fields and the raw payload bytes.

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Te6edf3sanitizeForExportTb4b4b4(Te6edf3logTb4b4b4.Te6edf3logMessageTb4b4b4)Tb4b4b4)

Tff7b72val Te6edf3decodedPayload Tff7b72= Te6edf3logTb4b4b4.Te6edf3decodedPayload

Tff7b72if Tb4b4b4(Tff7b72!Te6edf3decodedPayloadTb4b4b4.Te6edf3isNullOrBlankTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3appendRedactedPayloadTb4b4b4(Tff7b72outTb4b4b4, Te6edf3decodedPayloadTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e/**

* Renders one log entry for the per-entry copy action, sanitised the same way the file export is.

*

* Extracted from the composable so the sanitisation is covered by a test rather than by inspection.

*/

Tff7b72internal Tff7b72fun Td2a8ffformatLogEntryForCopyTb4b4b4(Te6edf3logTb4b4b4: Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Te6edf3sanitizeForExportTb4b4b4(

Te6edf3buildString Tb4b4b4{

Te6edf3appendTb4b4b4(Te6edf3logTb4b4b4.Te6edf3logMessageTb4b4b4)

Tff7b72if Tb4b4b4(Tff7b72!Te6edf3logTb4b4b4.Te6edf3decodedPayloadTb4b4b4.Te6edf3isNullOrBlankTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff\Ta5d6ffnDecoded Payload:Ta5d6ff\Ta5d6ffn{Ta5d6ff"Tb4b4b4)

Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Te6edf3appendTb4b4b4(Te6edf3logTb4b4b4.Te6edf3decodedPayloadTb4b4b4)

Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffn}Ta5d6ff"Tb4b4b4)

Tb4b4b4}

Tb4b4b4}Tb4b4b4,

Tb4b4b4)

T8b949e/**

* Appends captured Android logcat to [out] under a header, redacting sensitive keys line-by-line. The app should never

* log keys/PII, so this is defence-in-depth for a file the user is about to share on a public issue tracker.

*/

Tff7b72internal Tff7b72fun Td2a8ffappendLogcatTb4b4b4(Tff7b72outTb4b4b4: Te6edf3AppendableTb4b4b4, Te6edf3logcatTb4b4b4: Tffa657StringTb4b4b4) Tb4b4b4{

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffn===== App Logcat =====Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Te6edf3logcatTb4b4b4.Te6edf3lineSequenceTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3forEach Tb4b4b4{ Te6edf3line Tff7b72-Tff7b72>

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Te6edf3sanitizeForExportTb4b4b4(Te6edf3lineTb4b4b4)Tb4b4b4)

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffappendRedactedPayloadTb4b4b4(Tff7b72outTb4b4b4: Te6edf3AppendableTb4b4b4, Te6edf3payloadTb4b4b4: Tffa657StringTb4b4b4) Tb4b4b4{

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff\Ta5d6ffnDecoded Payload:Ta5d6ff\Ta5d6ffn{Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Te6edf3payloadTb4b4b4.Te6edf3lineSequenceTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3forEach Tb4b4b4{ Te6edf3line Tff7b72-Tff7b72>

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Te6edf3sanitizeForExportTb4b4b4(Te6edf3lineTb4b4b4)Tb4b4b4)

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Tb4b4b4}

Tff7b72outTb4b4b4.Te6edf3appendTb4b4b4(Ta5d6ff"Ta5d6ff}Ta5d6ff\Ta5d6ffnTa5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Tb4b4b4}

T8b949e/** Redacts sensitive-key values in every line of [text]; used to redact logcat both on screen and on export. */

Tff7b72internal Tff7b72fun Td2a8ffredactTextTb4b4b4(Te6edf3textTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Te6edf3textTb4b4b4.Te6edf3lineSequenceTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4) Tb4b4b4{ Te6edf3redactLineTb4b4b4(Tffa657itTb4b4b4) Tb4b4b4}

T8b949e/**

* Full sanitisation for text leaving the app — the file export and the per-entry copy action both use this.

*

* Sensitive-key redaction plus raw payload-byte suppression. Use this rather than [redactLine] anywhere log text is

* written to a file or the clipboard, since both end up pasted into public issue trackers.

*/

Tff7b72internal Tff7b72fun Td2a8ffsanitizeForExportTb4b4b4(Te6edf3textTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tff7b72=

Te6edf3textTb4b4b4.Te6edf3lineSequenceTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4) Tb4b4b4{ Te6edf3line Tff7b72-Tff7b72> Te6edf3suppressPayloadBytesTb4b4b4(Te6edf3redactLineTb4b4b4(Te6edf3lineTb4b4b4)Tb4b4b4) Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffredactLineTb4b4b4(Te6edf3lineTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tff7b72=

Te6edf3REDACT_REGEXTb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3lineTb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff2Tff7b72]Tffd700}Ta5d6ff<redacted>Ta5d6ff" Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffsuppressPayloadBytesTb4b4b4(Te6edf3lineTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tff7b72=

Te6edf3PAYLOAD_HEX_REGEXTb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3lineTb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff2Tff7b72]Tffd700}Ta5d6ff<suppressed>Ta5d6ff" Tb4b4b4}